docs(ci): add documentation explaining CI workflow structure#485
docs(ci): add documentation explaining CI workflow structure#485tomsebastian10 wants to merge 3 commits intourunc-dev:mainfrom
Conversation
Added detailed comments to the CI workflow for clarity.
Added a section on Continuous Integration (CI) detailing the CI pipeline and its components.
✅ Deploy Preview for urunc ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Hello @tomsebastian10 , thank you for your PR. While comments are always useful, I am not sure why the README should contain information about the CI. Also, please read and follow the contribution guide. |
Hi @cmainas, Thank you for pointing that out. I will remove the CI section from the README and instead place the documentation under the appropriate location in the I will also open an issue first as required and reference it in the PR. Thanks for the guidance! |
Removed Continuous Integration section from README
tomsebastian10
changed the title
tomsebastian10
changed the title
tomsebastian10
changed the title
2 participants
Summary
This PR improves the documentation and clarity of the main CI reusable workflow (
ci.yml).It adds:
Motivation
The CI workflow is a central part of the urunc development process, but new contributors may find it difficult to understand how the different jobs (linting, build, unit tests, E2E tests, Kubernetes tests) are connected.
Improving inline documentation makes the CI pipeline easier to understand and helps contributors quickly identify:
This change does not modify CI behavior — it only improves readability and maintainability.
Changes
Testing
No functional changes were introduced.
The workflow behavior remains unchanged.
Please let me know if any additional clarification would be helpful.